00001 <?php 00002 /*--------------------------------------------------------------------------+ 00003 This file is part of eStudy. 00004 user/classes/iface.userdataprovider.inc.php 00005 - Module group: Datenauszug 00006 - Description: Interface "UserDataProvider" 00007 - Version: $Id: iface.userdataprovider.inc.php 1465 2009-01-19 14:58:31Z bkasteleiner $ 00008 - Author(s): Philipp Hoffmann <philipp.hoffmann@mni.fh-giessen.de> 00009 - Bjoern Kasteleiner <bjoern.kasteleiner@mni.fh-giessen.de> 00010 - Bjoern Rathjens <bjoern.rathjens@mni.fh-giessen.de> 00011 +---------------------------------------------------------------------------+ 00012 This program is free software; you can redistribute it and/or 00013 modify it under the terms of the GNU General Public License 00014 as published by the Free Software Foundation; either version 2 00015 of the License, or any later version. 00016 +---------------------------------------------------------------------------+ 00017 This program is distributed in the hope that it will be useful, 00018 but WITHOUT ANY WARRANTY; without even the implied warranty of 00019 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 00020 GNU General Public License for more details. 00021 You should have received a copy of the GNU General Public License 00022 along with this program; if not, write to the Free Software 00023 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. 00024 +--------------------------------------------------------------------------*/ 00025 00029 interface UserDataProvider { 00030 /* 00031 * Die folgenden Konstanten dienen als Indizes des Arrays, 00032 * das nach einem Aufruf von <code>getUserData($userID)</code> zurückgegeben wird. 00033 */ 00034 const ID = 'id'; // ID des Datensatzes 00035 const DATE = 'date'; // Datum des Datensatzes 00036 const HINT = 'hint'; // Beschreibung des Datensatzes 00037 const CONTENT = 'content'; // Inhalt des Datensatzes 00038 const COURSE = 'course'; // Kurs-ID des Kurses, der den Datensatz enthält 00039 00040 /* 00041 * Diese Konstanten dienen ebenfalls als Indizes dieses Arrays, 00042 * werden aber nicht von einem <code>UserDataProvider</code> genutzt. 00043 * Sie dienen vielmehr der späteren Verarbeitung, beispielsweise durch <code>UserData</code>. 00044 */ 00045 const META = 'meta'; // Metadaten eines Kurses oder Moduls 00046 /* */ const MODULE = 'module'; // Weitere Daten (ID, Name, ...) eines Moduls 00047 /* */ const CLOSED = 'closed'; // Kurs wurde geschlossen 00048 /* */ const POLICY = 'policy'; // Kurs ist Prüfungsleistung 00049 /* 00050 * Die folgenden Punkte stehen noch aus: 00051 * 00052 * const DELETEABLE = 'deleteable'; 00053 * const ANONYM = 'anonym'; 00054 * const PSEUDONYM = 'pseudonym'; 00055 */ 00056 00063 public function getUserData($userID); 00064 00065 /* 00066 * Diese Methode löscht einen benutzerspezifischen Datensatz. 00067 * 00068 * @param int $userID die ID des Benutzers 00069 * @param int $courseID die ID des Kurses 00070 * @param int $resourceID die ID des Datensatzes 00071 * 00072 * public function deleteData($userID, $courseID, $resourceID); 00073 */ 00074 } 00075 ?>
1.5.5